Eclipse JDT
Pre-release 3.0

org.eclipse.jdt.ui.text
Class JavaSourceViewerConfiguration

java.lang.Object
  extended byorg.eclipse.jface.text.source.SourceViewerConfiguration
      extended byorg.eclipse.jdt.ui.text.JavaSourceViewerConfiguration

public class JavaSourceViewerConfiguration
extends SourceViewerConfiguration

Configuration for a source viewer which shows Java code.

This class may be instantiated; it is not intended to be subclassed.


Field Summary
static String PREFERENCE_TAB_WIDTH
          Preference key used to look up display tab width.
static String SPACES_FOR_TABS
          Preference key for inserting spaces rather than tabs.
 
Constructor Summary
JavaSourceViewerConfiguration(JavaTextTools tools, ITextEditor editor)
          Creates a new Java source viewer configuration for viewers in the given editor using the given Java tools.
JavaSourceViewerConfiguration(JavaTextTools tools, ITextEditor editor, String partitioning)
          Creates a new Java source viewer configuration for viewers in the given editor using the given Java tools and the specified document partitioning.
 
Method Summary
 IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer)
           
 IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer, String contentType)
           
protected  RuleBasedScanner getCodeScanner()
          Returns the Java source code scanner for this configuration.
protected  IColorManager getColorManager()
          Returns the color manager for this configuration.
 String[] getConfiguredContentTypes(ISourceViewer sourceViewer)
           
 String getConfiguredDocumentPartitioning(ISourceViewer sourceViewer)
           
 int[] getConfiguredTextHoverStateMasks(ISourceViewer sourceViewer, String contentType)
           
 IContentAssistant getContentAssistant(ISourceViewer sourceViewer)
           
 IContentFormatter getContentFormatter(ISourceViewer sourceViewer)
           
 String[] getDefaultPrefixes(ISourceViewer sourceViewer, String contentType)
           
 ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType)
           
protected  ITextEditor getEditor()
          Returns the editor in which the configured viewer(s) will reside.
 IInformationPresenter getHierarchyPresenter(ISourceViewer sourceViewer, boolean doCodeResolve)
           
 String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType)
           
 IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer)
           
 IInformationPresenter getInformationPresenter(ISourceViewer sourceViewer)
           
protected  RuleBasedScanner getJavaDocScanner()
          Returns the JavaDoc scanner for this configuration.
protected  RuleBasedScanner getMultilineCommentScanner()
          Returns the Java multiline comment scanner for this configuration.
 IInformationPresenter getOutlinePresenter(ISourceViewer sourceViewer, boolean doCodeResolve)
          Returns the outline presenter which will determine and shown information requested for the current cursor position.
 IAnnotationHover getOverviewRulerAnnotationHover(ISourceViewer sourceViewer)
           
 IPreferenceStore getPreferenceStore()
          Returns the preference store used by this configuration to initialize the individual bits and pieces.
 IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer)
           
 IReconciler getReconciler(ISourceViewer sourceViewer)
           
protected  RuleBasedScanner getSinglelineCommentScanner()
          Returns the Java singleline comment scanner for this configuration.
protected  RuleBasedScanner getStringScanner()
          Returns the Java string scanner for this configuration.
 int getTabWidth(ISourceViewer sourceViewer)
           
 ITextHover getTextHover(ISourceViewer sourceViewer, String contentType)
           
 ITextHover getTextHover(ISourceViewer sourceViewer, String contentType, int stateMask)
           
 
Methods inherited from class org.eclipse.jface.text.source.SourceViewerConfiguration
getUndoManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PREFERENCE_TAB_WIDTH

public static final String PREFERENCE_TAB_WIDTH
Preference key used to look up display tab width.

Since:
2.0
See Also:
Constant Field Values

SPACES_FOR_TABS

public static final String SPACES_FOR_TABS
Preference key for inserting spaces rather than tabs.

Since:
2.0
See Also:
Constant Field Values
Constructor Detail

JavaSourceViewerConfiguration

public JavaSourceViewerConfiguration(JavaTextTools tools,
                                     ITextEditor editor,
                                     String partitioning)
Creates a new Java source viewer configuration for viewers in the given editor using the given Java tools and the specified document partitioning.

Parameters:
tools - the Java text tools to be used
editor - the editor in which the configured viewer(s) will reside
partitioning - the document partitioning for this configuration
Since:
3.0
See Also:
JavaTextTools

JavaSourceViewerConfiguration

public JavaSourceViewerConfiguration(JavaTextTools tools,
                                     ITextEditor editor)
Creates a new Java source viewer configuration for viewers in the given editor using the given Java tools.

Parameters:
tools - the Java text tools to be used
editor - the editor in which the configured viewer(s) will reside
See Also:
JavaTextTools
Method Detail

getCodeScanner

protected RuleBasedScanner getCodeScanner()
Returns the Java source code scanner for this configuration.

Returns:
the Java source code scanner

getMultilineCommentScanner

protected RuleBasedScanner getMultilineCommentScanner()
Returns the Java multiline comment scanner for this configuration.

Returns:
the Java multiline comment scanner
Since:
2.0

getSinglelineCommentScanner

protected RuleBasedScanner getSinglelineCommentScanner()
Returns the Java singleline comment scanner for this configuration.

Returns:
the Java singleline comment scanner
Since:
2.0

getStringScanner

protected RuleBasedScanner getStringScanner()
Returns the Java string scanner for this configuration.

Returns:
the Java string scanner
Since:
2.0

getJavaDocScanner

protected RuleBasedScanner getJavaDocScanner()
Returns the JavaDoc scanner for this configuration.

Returns:
the JavaDoc scanner

getColorManager

protected IColorManager getColorManager()
Returns the color manager for this configuration.

Returns:
the color manager

getEditor

protected ITextEditor getEditor()
Returns the editor in which the configured viewer(s) will reside.

Returns:
the enclosing editor

getPreferenceStore

public IPreferenceStore getPreferenceStore()
Returns the preference store used by this configuration to initialize the individual bits and pieces.

Returns:
the preference store used to initialize this configuration
Since:
2.0

getPresentationReconciler

public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer)

getContentAssistant

public IContentAssistant getContentAssistant(ISourceViewer sourceViewer)

getReconciler

public IReconciler getReconciler(ISourceViewer sourceViewer)

getAutoIndentStrategy

public IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer,
                                                 String contentType)

getDoubleClickStrategy

public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer,
                                                       String contentType)

getDefaultPrefixes

public String[] getDefaultPrefixes(ISourceViewer sourceViewer,
                                   String contentType)

getIndentPrefixes

public String[] getIndentPrefixes(ISourceViewer sourceViewer,
                                  String contentType)

getTabWidth

public int getTabWidth(ISourceViewer sourceViewer)

getAnnotationHover

public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer)

getOverviewRulerAnnotationHover

public IAnnotationHover getOverviewRulerAnnotationHover(ISourceViewer sourceViewer)

getConfiguredTextHoverStateMasks

public int[] getConfiguredTextHoverStateMasks(ISourceViewer sourceViewer,
                                              String contentType)

getTextHover

public ITextHover getTextHover(ISourceViewer sourceViewer,
                               String contentType,
                               int stateMask)

getTextHover

public ITextHover getTextHover(ISourceViewer sourceViewer,
                               String contentType)

getConfiguredContentTypes

public String[] getConfiguredContentTypes(ISourceViewer sourceViewer)

getConfiguredDocumentPartitioning

public String getConfiguredDocumentPartitioning(ISourceViewer sourceViewer)

getContentFormatter

public IContentFormatter getContentFormatter(ISourceViewer sourceViewer)

getInformationControlCreator

public IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer)

getInformationPresenter

public IInformationPresenter getInformationPresenter(ISourceViewer sourceViewer)

getOutlinePresenter

public IInformationPresenter getOutlinePresenter(ISourceViewer sourceViewer,
                                                 boolean doCodeResolve)
Returns the outline presenter which will determine and shown information requested for the current cursor position.

Parameters:
sourceViewer - the source viewer to be configured by this configuration
doCodeResolve - a boolean which specifies whether code resolve should be used to compute the Java element
Returns:
an information presenter
Since:
2.1

getHierarchyPresenter

public IInformationPresenter getHierarchyPresenter(ISourceViewer sourceViewer,
                                                   boolean doCodeResolve)

Eclipse JDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.